home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / music / kardp11.zip / KARA.MAN < prev    next >
Text File  |  1994-12-23  |  8KB  |  200 lines
  1.  
  2. KARA.MAN                   USER COMMANDS               KARA.MAN
  3.  
  4. NAME
  5.      kara.exe
  6.  
  7. SYNOPSIS
  8.     [path1\]kara [path2\]song
  9.     [-do={v/f}] [-po={s/m}]
  10.     [-hd={GUS/SB}]
  11.     [-dc=y] [-tc=y]
  12.     [-sz=x] [-ft=x]
  13.     [-ff=x] [-nb=x] [-af=x] [-ab=x] [-pf=x] [-st=x]
  14.  
  15.      with x = numerical value (see OPTIONS)
  16.  
  17.  
  18. AVAILABILITY
  19.      The kara command is available within the kardp11.zip package
  20.      This package contains the KaraDos product delivery.
  21.      The package kards01.zip contains karaoke files collection 01
  22.  
  23. DESCRIPTION
  24.      kara  is  a  midi song player with karaoke features for dos.
  25.      Song  may be directed to the  Gravis UltraSound  card  (GUS)
  26.      internal synth with the  ultramid utility or directed to the
  27.      midi output of the  GUS or SoundBlaster and compatible card.
  28.      The hardware is automatically detected  or specified with  a
  29.      parameter.
  30.  
  31.      Text is directed to the screen in  either  full screen  with
  32.      full background and foreground colors capacity and choice of
  33.      characters size and style, or either in a video mode used to
  34.      become embedded in a video signal on tv set at the bottom of
  35.      the screen. In video mode the background color is black.
  36.  
  37.      Two kind of song files are understood by kara :
  38.        - midi file with .mid extension
  39.        - karaoke file with .kar extension (karasoft format)
  40.      Midi files must have a text file associated  with each song.
  41.      The file name of these text files must be  the same  as  the
  42.      midi file with a .txk extension. Synchronization is  made on
  43.      the note on and off of a  midi channel. A  complete descrip-
  44.      tion of the .txk format is done in the following.
  45.  
  46.      If no lyric, the display will show the midi channel activity
  47.      while the music play.
  48.  
  49.      While playing, the music can be stopped, continued, transpo-
  50.      sed. The tempo can be adjusted and the volume of the  synch-
  51.      ronization channel tuned. Valid keys are space to start  and
  52.      stop the music, r (rythm) t (transpose) v (volume)  followed
  53.      with + or -, and esc to quit.
  54.      For each key, an indication is briefly displayed at the left
  55.      upper corner of the screen.
  56.      Note on the volume: with a .mid & .txk set,  the  volume  is
  57.      adjusted only for the synchro channel.
  58.      For a .kar file, the volume is adjusted for all channels.
  59.      The key M (monitor) will play the music on the pc speaker
  60.      (channel 1 to 8 only << only for debug  don't  use for  your
  61.      health >>)
  62.  
  63.      From the 1.1 version, other valid keys are added :
  64.      PageUp, PageDown, Home, and right arrow.
  65.      PageUp will restart song and lyrics at the previews scrolling
  66.      PageDown will advance to the next scrolling,Home will restart
  67.      song and lyrics from the beginning, and the right arrow  will
  68.      temporary speed up while the key is depressed.
  69.      If no lyric, Page up and down give +/- 10% in music.
  70.  
  71.  
  72. MIDI CHANNEL DISPLAY
  73.      The MIDI channel display is a screen displayed when  no lyric
  74.      is associated to a .mid file or for others when the enter key
  75.      is depressed (toggle mode).  This screen  shows the  channels
  76.      activities while playing and the instrument associated.
  77.  
  78.  
  79. DEFAULT CONFIGURATION
  80.      Options that must remain permanent for a configuration may be
  81.      given in a kara.cfk file in the same directory than kara.exe.
  82.      the format of this file is identical to the  text  song  file
  83.      without lyric obviously.
  84.      kara.cfk options overload ka.exe default options.
  85.  
  86.  
  87. OPTIONS
  88.      OPTION     COMMENT                                   DEFAULT
  89.      ------------------------------------------------------------
  90.   kara options
  91.      -do={v/f}  display text in full screen or video mode    do=f
  92.      -po={s/m}  music to ultramid (synth) or midi port       po=s
  93.      -hd={GUS/SB} to skip the automatic detection            none
  94.       this option is usefull only for the midi port output.
  95.   music options
  96.      -dc={1.16} drum channel number                         dc=10
  97.      -tc={1.16} text synchro channel (for .mid file)         tc=1
  98.   screen options
  99.      -sz={0.10}  size of the text on the screen              sz=4
  100.      -ft={0.4}  type of font                                 ft=1
  101.   line options
  102.      -ff={0.15} first text foreground color                 ff=15
  103.      -nb={0.15} normal background color in full screen       nb=1
  104.      -af={0.15} active text foreground color                 af=0
  105.      -ab={0.15} active text background color in full screen ab=14
  106.      -pf={0.15} post text foreground color                   pf=3
  107.      -st={0.11} fill style of the background                 st=0
  108.  
  109. COLORS
  110.      Color        |Value|
  111.      --------------------
  112.      BLACK        |  0  |
  113.      BLUE         |  1  |
  114.      GREEN        |  2  |
  115.      CYAN         |  3  |
  116.      RED          |  4  |
  117.      MAGENTA      |  5  |
  118.      BROWN        |  6  |
  119.      LIGHTGRAY    |  7  |
  120.      DARKGRAY     |  8  |
  121.      LIGHTBLUE    |  9  |
  122.      LIGHTGREEN   | 10  |
  123.      LIGHTCYAN    | 11  |
  124.      LIGHTRED     | 12  |
  125.      LIGHTMAGENTA | 13  |
  126.      YELLOW       | 14  |
  127.      WHITE        | 15  |
  128.     ---------------------
  129.      Note :Colors depends on your hardware,CGA,EGA or VGA screen.
  130.  
  131. STYLES
  132.      Style name    |Value|
  133.      --------------------
  134.      EMPTY FILL       0
  135.      SOLID FILL       1
  136.      LINE  FILL       2
  137.      LTSLASH FILL     3
  138.      SLASH FILL       4
  139.      BKSLASH FILL     5
  140.      LTBKSLASH FILL   6
  141.      HATCH FILL       7
  142.      XHATCH FILL      8
  143.      INTERLEAVE FILL  9
  144.      WIDE DOT FILL    10
  145.      CLOSE DOT FILL   11
  146.  
  147.  
  148. FORMAT
  149.      Format of the .txk ascii file and kara.cfk file:
  150.      -----------------------------------------------
  151.      The two  first lines are reserved for the  title, author and
  152.      copyright if any.
  153.      Following  lines are a mix of text lines and attribut lines.
  154.  
  155.      Text lines  are  as you want to see it on the  screen  apart
  156.      a syllable separator. Valid separators are blank - , ;
  157.      the - separator is not displayed
  158.      for example the line: i be-come la-zy
  159.      is displayed as : i become lazy  but is "karaoked" as :
  160.      i be come la zy     . It is more  easy to understand than to
  161.      explain.
  162.  
  163.      Attribut lines begin with # followed with one option descri-
  164.      bed in the OPTIONS . Warning: the # replace the - character.
  165.      A new option is added : #rem for adding a comment line.
  166.      Kara option #do and #po are disabled and will not work.
  167.      Only music, screen and line options will be given in a  .txk
  168.      file.
  169.      A line option remains valid until the same is given.
  170.      The screen options taken into account are the last given.
  171.  
  172.      .txk options overload options given in the  command line or
  173.      in the kara.cfk file.
  174.  
  175.      kara.cfk options are overloaded with any other options  from
  176.      the command line or the .txk file.
  177.  
  178.  
  179.      Formatting the ascii text in .kar file :
  180.      ----------------------------------------
  181.      A text beginning with the character / or with an uppercase
  182.      is displayed on a new line.
  183.      A text beginning with the character \ is displayed after two
  184.      empty line ( note: normally it will be a new screen. It's my
  185.      choice).
  186.  
  187.  
  188. SEE ALSO
  189.      kdir.man
  190.  
  191. BUGS AND RESTRICTIONS
  192.      Some font and size combinations may not work perfectly.
  193.      Files *.chr and *.bgi must reside in the same directory as
  194.      kara.exe.
  195.      Files .txk must be in the same directory than corresponding
  196.      .mid files
  197.      Some karaoke files may be too large to fit in DOS memory.
  198.  
  199. KaraDos release 1.1 Last change: 23 December 1994 (c)JP COCATRIX
  200.